From a5980a4e95a125e96606c4b75b857034c92d6b81 Mon Sep 17 00:00:00 2001
From: tsteven4 <13596209+tsteven4@users.noreply.github.com>
Date: Fri, 18 Feb 2022 11:04:01 -0700
Subject: [PATCH] use precompiled headers to speed up compile time (#851)

* speed up compiles with precompiled headers.

* workaround QTBUG with precompiled headers and clang.

* avoid including QtCore.

* add ability to turn off precompiled headers.
---
 .gitignore              |  1 +
 CMakeLists.txt          | 23 +++++++++++++++++++++++
 GPSBabel.pro            |  9 +++++++++
 mynav.cc                |  2 +-
 precompiled_headers.h   | 41 +++++++++++++++++++++++++++++++++++++++++
 src/core/codecdevice.cc |  2 +-
 src/core/codecdevice.h  |  3 ++-
 src/core/textstream.cc  |  2 +-
 8 files changed, 79 insertions(+), 4 deletions(-)
 create mode 100644 precompiled_headers.h

diff --git a/.gitignore b/.gitignore
index 957c3cac4..096b82de5 100644
--- a/.gitignore
+++ b/.gitignore
@@ -36,6 +36,7 @@ CMakeFiles/
 *.swp
 /tmp/
 /mkcapabilities
+/gpsbabel.gch/
 /gpsbabel.rc
 /autogen/
 /makedoc
diff --git a/CMakeLists.txt b/CMakeLists.txt
index 7dcb4d4a9..d0acd5774 100644
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -39,6 +39,29 @@ if(${QT_VERSION_MAJOR} EQUAL "6")
   list(APPEND QT_LIBRARIES Qt${QT_VERSION_MAJOR}::Core5Compat)
 endif()
 
+option(GPSBABEL_ENABLE_PCH "enable precompiled headers." ON)
+if (GPSBABEL_ENABLE_PCH)
+  target_precompile_headers(gpsbabel PRIVATE
+    "$<$<COMPILE_LANGUAGE:CXX>:<algorithm$<ANGLE-R>>"
+    "$<$<COMPILE_LANGUAGE:CXX>:<cmath$<ANGLE-R>>"
+    "$<$<COMPILE_LANGUAGE:CXX>:<cstdarg$<ANGLE-R>>"
+    "$<$<COMPILE_LANGUAGE:CXX>:<cstddef$<ANGLE-R>>"
+    "$<$<COMPILE_LANGUAGE:CXX>:<cstdint$<ANGLE-R>>"
+    "$<$<COMPILE_LANGUAGE:CXX>:<cstdio$<ANGLE-R>>"
+    "$<$<COMPILE_LANGUAGE:CXX>:<ctime$<ANGLE-R>>"
+    "$<$<COMPILE_LANGUAGE:CXX>:<optional$<ANGLE-R>>"
+    "$<$<COMPILE_LANGUAGE:CXX>:<utility$<ANGLE-R>>"
+    "$<$<COMPILE_LANGUAGE:CXX>:<QDebug$<ANGLE-R>>"
+    "$<$<COMPILE_LANGUAGE:CXX>:<QList$<ANGLE-R>>"
+    "$<$<COMPILE_LANGUAGE:CXX>:<QScopedPointer$<ANGLE-R>>"
+    "$<$<COMPILE_LANGUAGE:CXX>:<QString$<ANGLE-R>>"
+    "$<$<COMPILE_LANGUAGE:CXX>:<QTextCodec$<ANGLE-R>>"
+    "$<$<COMPILE_LANGUAGE:CXX>:<QVector$<ANGLE-R>>"
+    "$<$<COMPILE_LANGUAGE:CXX>:<Qt$<ANGLE-R>>"
+    "$<$<COMPILE_LANGUAGE:CXX>:<QtGlobal$<ANGLE-R>>"
+  )
+endif()
+
 # RESOURCES
 set(RESOURCES gpsbabel.qrc)
 
diff --git a/GPSBabel.pro b/GPSBabel.pro
index 49faaaf01..47b2be048 100644
--- a/GPSBabel.pro
+++ b/GPSBabel.pro
@@ -26,6 +26,15 @@ CONFIG += console
 CONFIG -= app_bundle
 CONFIG += c++17
 CONFIG += link_pkgconfig
+!disable_pch {
+  # avoid QTBUG-72404, QTBUG-79694 which were fixed in 5.14.0
+  versionAtLeast(QT_VERSION, 5.14.0) | !contains(QMAKE_CXX, .*clang.*) {
+    CONFIG += precompile_header
+    PRECOMPILED_HEADER = precompiled_headers.h
+  } else {
+    message("Not using precompiled headers due to QTBUG.")
+  }
+}
 
 TEMPLATE = app
 
diff --git a/mynav.cc b/mynav.cc
index f2fbf982e..5fbe9b902 100644
--- a/mynav.cc
+++ b/mynav.cc
@@ -30,7 +30,7 @@
 #include <QStringList>
 #include <QtGlobal>
 
-#include <src/core/textstream.h>
+#include "src/core/textstream.h"
 
 #include "mynav.h"
 
diff --git a/precompiled_headers.h b/precompiled_headers.h
new file mode 100644
index 000000000..47705c843
--- /dev/null
+++ b/precompiled_headers.h
@@ -0,0 +1,41 @@
+/*
+    Copyright (C) 2002-2014 Robert Lipe, robertlipe+source@gpsbabel.org
+
+    This program is free software; you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation; either version 2 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program; if not, write to the Free Software
+    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+
+ */
+
+// This list is from defs.h.  Adding other commonly used headers doesn't help.
+
+#if defined __cplusplus
+#include <algorithm>              // for sort, stable_sort
+#include <cmath>                  // for M_PI
+#include <cstdarg>                // for va_list
+#include <cstddef>                // for NULL, nullptr_t, size_t
+#include <cstdint>                // for int32_t, uint32_t
+#include <cstdio>                 // for NULL, fprintf, FILE, stdout
+#include <ctime>                  // for time_t
+#include <optional>               // for optional
+#include <utility>                // for move
+
+#include <QDebug>                 // for QDebug
+#include <QList>                  // for QList, QList<>::const_reverse_iterator, QList<>::reverse_iterator
+#include <QScopedPointer>         // for QScopedPointer
+#include <QString>                // for QString
+#include <QTextCodec>             // for QTextCodec
+#include <QVector>                // for QVector
+#include <Qt>                     // for CaseInsensitive
+#include <QtGlobal>               // for foreach
+#endif
diff --git a/src/core/codecdevice.cc b/src/core/codecdevice.cc
index 13290d014..77e322e45 100644
--- a/src/core/codecdevice.cc
+++ b/src/core/codecdevice.cc
@@ -17,12 +17,12 @@
 
  */
 
+#include <cassert>     // for assert
 #include <cstring>     // for memcpy
 #include <algorithm>   // for min
 
 #include <QByteArray>  // for QByteArray
 #include <QChar>       // for QChar
-#include <QFile>       // for QFile
 #include <QFlags>      // for QFlags
 
 #include "defs.h"      // for list_codecs, warning
diff --git a/src/core/codecdevice.h b/src/core/codecdevice.h
index 320d9aa90..6ccb7e8ac 100644
--- a/src/core/codecdevice.h
+++ b/src/core/codecdevice.h
@@ -18,11 +18,12 @@
  */
 
 #include <QIODevice>        // for QIODevice
+#include <QIODeviceBase>    // for QIODeviceBase::OpenMode
 #include <QString>          // for QString
 #include <QTextCodec>       // for QTextCodec
 #include <QTextDecoder>     // for QTextDecoder
 #include <QTextEncoder>     // for QTextEncoder
-#include <QtCore>           // for qint64, QIODeviceBase::OpenMode
+#include <QtGlobal>         // for qint64
 
 #include "src/core/file.h"  // for File
 
diff --git a/src/core/textstream.cc b/src/core/textstream.cc
index 49c10ba88..2b6f1140e 100644
--- a/src/core/textstream.cc
+++ b/src/core/textstream.cc
@@ -18,7 +18,7 @@
  */
 
 
-#include <QtCore>            // for qint64, QT_VERSION, QT_VERSION_CHECK
+#include <QtGlobal>          // for qint64, QT_VERSION, QT_VERSION_CHECK
 
 #if (QT_VERSION >= QT_VERSION_CHECK(6, 0, 0))
 #include <QByteArrayView>    // for QByteArrayView
-- 
2.30.2